d払い

d払い(継続課金) API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却
Request header
Content-Type: application/json;charset=UTF-8
Method
POST
Response header
Content-Type: application/json;charset=UTF-8
Status Code
  • 200：正常時
  • 400：入力パラメータエラー、加盟店設定エラー
  • 500：システムエラー
  • 502：決済エラー
　　　　　　　
    ※以下のエラーコードはhttp200で返却される可能性がございます。
    　 ・E90010001
    　 ・E92000001
    　 ・E92000002
    　 ・E91099996
    　 ・E91099997

EntryTranDocomoContinuance 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID
Amount amount 必須 半角数字6桁
利用金額

Tax tax 半角数字6桁
税送料

税送料を指定した場合は、利用金額＋税送料が決済金額となります。
利用金額＋税送料で1円以上、ショップ上限金額以下である必要があります。

URL
/payment/EntryTranDocomoContinuance.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "amount": "1000"
}
URL
/payment/EntryTranDocomoContinuance.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&Amount=1000
レスポンス
正常
AccessID accessID 半角英数32桁 固定
取引ID
AccessPass accessPass 半角英数32桁 固定
取引パスワード
異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranDocomoContinuance 決済実行

これ以降の決済取引で必要となるトークンを返却します。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID
ClientField1 clientField1 全半角100バイト
加盟店自由項目1
ClientField2 clientField2 全半角100バイト
加盟店自由項目2
ClientField3 clientField3 全半角100バイト
加盟店自由項目3
DocomoDisp1 docomoDisp1 全半角40バイト
ドコモ表示項目1
DocomoDisp2 docomoDisp2 全半角40バイト
ドコモ表示項目2
RetURL retURL 必須 半角英数記号256桁
決済結果戻しURL

加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。
d払い画面上でお客様が認証、操作をキャンセルした場合や、当サービスにて登録処理を実行した場合に指定されたURLに結果がリダイレクト経由で送信されます。

PaymentTermSec paymentTermSec 半角数字5桁
支払開始期限秒

お客様が【決済実行】から【支払手続き開始IF】を呼び出すまでの期限です。
最大86,400秒（1日）
呼び出しパラメータが空の場合、120秒で処理されます。

FirstMonthFreeFlag firstMonthFreeFlag 必須 半角数字1桁
初月無料区分

初月の課金を無料にするか指定します。
0：初月無料にしない
1：初月無料にする

ConfirmBaseDate confirmBaseDate 必須 半角数字2桁
確定基準日

月々の継続課金を確定する日を指定します。
有効な日付は10,15,20,25,31です。
尚、31の場合は毎月月末に継続課金データを確定します。

DispCompanyName dispCompanyName 全半角32バイト
会社名
DispShopName dispShopName 全半角32バイト
利用店舗名
DispPhoneNumber dispPhoneNumber 半角数字13桁
連絡先電話番号
DispMailAddress dispMailAddress 半角英数記号96桁
メールアドレス
DispShopUrl dispShopUrl 半角英数記号96桁
問い合わせURL

※ 直接契約加盟店様は、DispCompanyName～DispShopUrlの指定は不要です。

※ DispPhoneNumber～DispShopUrlの設定値の合計バイト数を96バイト以内にしてください。

URL
/payment/ExecTranDocomoContinuance.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "retURL": "https://example.com/receive",
  "firstMonthFreeFlag": "1",
  "confirmBaseDate": "31"
}
URL
/payment/ExecTranDocomoContinuance.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive&FirstMonthFreeFlag=1&ConfirmBaseDate=31
レスポンス
正常
AccessID accessID 半角英数32桁 固定
アクセスID
Token token 半角英数記号256桁 固定
トークン

アクセスIDのハッシュ値を返却します。

StartURL startURL 半角英数記号256桁
支払手続き開始IFのURL

支払手続き開始IFのURLを返却します。

StartLimitDate startLimitDate 半角数字14桁 固定
支払開始期限日時

支払手続き開始IFの呼び出し期限を返却します。
yyyyMMddHHmmss書式

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "token": "qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL",
  "startURL": "https://x01.mul-pay.jp/payment/DocomoContinuanceStart.idPass",
  "startLimitDate": "20190225162711"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL&StartURL=https://x01.mul-pay.jp/payment/DocomoContinuanceStart.idPass&StartLimitDate=20190225162711
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

DocomoContinuanceStart 支払手続き開始IFの呼び出し

お客様をd払い画面へ誘導します。
※取引が特定できない場合、すでに登録を済ませている場合、期限切れの場合等はエラー画面を表示します。

リクエスト
AccessID 必須 半角英数32桁 固定
取引ID
Token 必須 半角英数記号256桁 固定
トークン

URL
/payment/DocomoContinuanceStart.idPass
リクエストパラメータ
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL
リダイレクトページサンプル

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="DocomoStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
    <noscript>
      <br>
      <br>
      <center>
        <h2>
          d払い継続課金の登録画面へ遷移します。
        </h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script>
    <!--
      function OnLoadEvent() {
        document.DocomoStartCall.submit();
      }
    //-->
    </script>
    </body>
</html>

登録結果受信

NTTドコモ社から、当サービスに認証・登録操作結果が通知されます。
認証・登録操作結果は、お客様が登録操作を完了した場合と認証・登録操作をキャンセルした場合に通知されます。
当サービスは、【決済実行】時に指定されたリダイレクトURLに登録結果を通知します。
この登録結果は、d払いの登録完了画面からブラウザ経由で連携されるため、ユーザの操作方法によっては登録操作が完了したにもかかわらず、加盟店様に通知されないことがあります。その際はショップ管理画面または結果通知にて確認ください。
また、同様の理由でこの登録結果が複数回加盟店様に通知されることがあります。

レスポンス
正常
ShopID 半角英数13桁
ショップID

OrderID 半角英数記号27桁
オーダーID

Status
現状態

該当取引の取引状態を返却します。
REGISTER：契約中
PAYFAIL：決済失敗
TranDate 半角数字14桁 固定
処理日時

当サービスで処理を実施した日時を返却します。
yyyyMMddHHmmss書式
DocomoSettlementCode 半角数字12桁
ドコモ決済番号
異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード

DocomoContinuanceUserChange 金額変更(お客様)

お客様の端末から金額変更を行います。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID
Amount amount 必須 半角数字6桁
利用金額
Tax tax 半角数字6桁
税送料

税送料を指定した場合は、利用金額＋税送料が決済金額となります。
利用金額＋税送料で1円以上ショップ上限金額以下である必要があります。

DocomoDisp1 docomoDisp1 全半角40バイト
ドコモ表示項目1
DocomoDisp2 docomoDisp2 全半角40バイト
ドコモ表示項目2
RetURL retURL 必須 半角英数記号256桁
決済結果戻しURL

加盟店様が当サービスからの登録結果を受信する為の登録受信URLを設定します。
d払い画面上でお客様が認証、登録操作をキャンセルした場合や、当サービスにて登録処理を実行した場合に指定されたURLに結果がリダイレクト経由で送信されます。

PaymentTermSec paymentTermSec 半角数字5桁
支払開始期限秒

お客様が【決済実行】から【支払手続き開始IF】を呼び出すまでの期限です。
最大86,400秒（1日）
呼び出しパラメータが空の場合、120秒で処理されます。

URL
/payment/DocomoContinuanceUserChange.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1100",
  "retURL": "https://example.com/receive"
}
URL
/payment/DocomoContinuanceUserChange.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1100&RetURL=https://example.com/receive
レスポンス
正常
AccessID accessID 半角英数32桁 固定
アクセスID
Token token 半角英数記号256桁 固定
トークン

アクセスIDのハッシュ値を返却します。

StartURL startURL 半角英数記号256桁
変更手続き開始IFのURL

変更手続き開始IFのURLを返却します。

StartLimitDate startLimitDate 半角数字14桁 固定
支払開始期限日時

支払手続き開始IFの呼び出し期限を返却します。
yyyyMMddHHmmss書式

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "token": "",
  "startURL": "",
  "startLimitDate": "20190225162711"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=&StartURL=&StartLimitDate=20190225162711
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

DocomoContinuanceUserChangeStart 金額変更(お客様)開始IFの呼び出し

お客様をd払い画面へ誘導します。
金額変更(お客様)の次に呼び出す必要があります。

リクエスト
AccessID 必須 半角英数32桁 固定
取引ID
Token 必須 半角英数記号256桁 固定
トークン

URL
/payment/DocomoContinuanceUserChangeStart.json
リクエストパラメータ
{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "token": "qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL"
}
URL
/payment/DocomoContinuanceUserChangeStart.idPass
リクエストパラメータ
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL
リダイレクトページサンプル

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="DocomoStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
    <noscript>
      <br>
      <br>
      <center>
        <h2>
          d払い継続課金の変更画面へ遷移します。
        </h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script>
    <!--
      function OnLoadEvent() {
        document.DocomoStartCall.submit();
      }
    //-->
    </script>
    </body>
</html>

変更結果受信

NTTドコモ社から、当サービスに認証・変更操作結果が通知されます。
認証・変更操作結果は、お客様が変更操作を完了した場合と認証・操作をキャンセルした場合に通知されます。
当サービスは、【決済実行】時に指定されたリダイレクトURLに変更結果を通知します。

レスポンス
正常
ShopID 半角英数13桁
ショップID

OrderID 半角英数記号27桁
オーダーID

Status
現状態

該当取引の取引状態を返却します。
REGISTER：登録済
TranDate 半角数字14桁 固定
処理日時

当サービスで処理を実施した日時を返却します。
yyyyMMddHHmmss書式
DocomoSettlementCode 半角数字12桁
ドコモ決済番号
異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード

DocomoContinuanceShopChange 金額変更(加盟店様)

加盟店様にて基本データの金額変更を行います。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID
Amount amount 必須 半角数字6桁
利用金額
Tax tax 半角数字6桁
税送料

利用金額＋税送料が変更金額となります。（1円以上）

URL
/payment/DocomoContinuanceShopChange.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1100"
}
URL
/payment/DocomoContinuanceShopChange.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1100
レスポンス
正常
OrderID orderID 半角英数記号27桁
オーダーID
Status status
現状態

金額変更成功時は以下のステータスが返却されます。
・RUN-CHANGE：変更処理中

Amount amount 半角数字6桁
利用金額
変更前の利用金額を返却します。
Tax tax 半角数字6桁
税送料
変更前の利用税送料を返却します。
ChangeAmount changeAmount 半角数字6桁
変更後利用金額
ChangeTax changeTax 半角数字6桁
変更後税送料
異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "orderID": "ORDER0000001",
  "status": "RUN-CHANGE",
  "amount": "1000",
  "tax": "0",
  "changeAmount": "1100",
  "changeTax": "0"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=RUN-CHANGE&Amount=1000&Tax=0&ChangeAmount=1100&ChangeTax=0
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

DocomoContinuanceUserEnd 継続課金終了(お客様)

お客様の端末から継続課金の終了を行います。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID
Amount amount 必須 半角数字6桁
利用金額
Tax tax 半角数字6桁
税送料
DocomoDisp1 docomoDisp1 全半角40バイト
ドコモ表示項目1
DocomoDisp2 docomoDisp2 全半角40バイト
ドコモ表示項目2
RetURL retURL 必須 半角英数記号256桁
決済結果戻しURL

加盟店様が当サービスからの終了結果を受信する為の結果受信URLを設定します。
d払い画面上でお客様が認証、終了操作をキャンセルした場合や、当サービスにて終了処理を実行した場合に指定されたURLに結果がリダイレクト経由で送信されます。

PaymentTermSec paymentTermSec 半角数字5桁
終了手続き開始期限秒

お客様が【決済実行】から【終了手続き開始IF】を呼び出すまでの期限です。
最大86,400秒（1日）
呼び出しパラメータが空の場合、120秒で処理されます。

LastMonthFreeFlag lastMonthFreeFlag 必須 半角数字1桁
終了月無料区分

終了月の課金を無料にするか指定します。
0：終了月無料にしない
1：終了月無料にする

URL
/payment/DocomoContinuanceUserEnd.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1000",
  "retURL": "https://example.com/receive",
  "lastMonthFreeFlag": "0"
}
URL
/payment/DocomoContinuanceUserEnd.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000&RetURL=https://example.com/receive&LastMonthFreeFlag=0
レスポンス
正常
AccessID accessID 半角英数32桁 固定
アクセスID
Token token 半角英数記号256桁 固定
トークン

アクセスIDのハッシュ値を返却します。

StartURL startURL 半角英数記号256桁
終了手続き開始IFのURL

終了手続き開始IFのURLを返却します。

StartLimitDate startLimitDate 半角数字14桁 固定
終了開始期限日時

終了手続き開始IFの呼び出し期限を返却します。
yyyyMMddHHmmss書式

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "token": "qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL",
  "startURL": "https://x01.mul-pay.jp/payment/DocomoContinuanceUserEndStart.idPass",
  "startLimitDate": "20190225162711"
}
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL&StartURL=https://x01.mul-pay.jp/payment/DocomoContinuanceUserEndStart.idPass&StartLimitDate=20190225162711
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

DocomoContinuanceUserEndStart 継続課金終了(お客様)開始IFの呼び出し

お客様をd払い画面へ誘導します。
継続課金終了(お客様)の次に呼び出す必要があります。

リクエスト
AccessID accessID 必須 半角英数32桁 固定
取引ID
Token token 必須 半角英数記号256桁 固定
トークン

URL
/payment/DocomoContinuanceUserEndStart.idPass
リクエストパラメータ
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL
リダイレクトページサンプル

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="DocomoStartCall" action="{決済実行のレスポンスで返却した接続先URL}" method="POST">
    <noscript>
      <br>
      <br>
      <center>
        <h2>
          d払い継続課金の終了画面へ遷移します。
        </h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script>
    <!--
      function OnLoadEvent() {
        document.DocomoStartCall.submit();
      }
    //-->
    </script>
    </body>
</html>

終了結果受信

NTTドコモ社から、当サービスに認証・終了操作結果が通知されます。
認証・終了操作結果は、お客様が終了操作を完了した場合と認証・終了操作をキャンセルした場合に通知されます。
当サービスは、【決済実行】時に指定されたリダイレクトURLに結果を通知します。

レスポンス
正常
ShopID 半角英数13桁
ショップID

OrderID 半角英数記号27桁
オーダーID

Status
現状態

該当取引の取引状態を返却します。
END：契約終了
TranDate 半角数字14桁 固定
処理日時

当サービスで処理を実施した日時を返却します。
yyyyMMddHHmmss書式
DocomoSettlementCode 半角数字12桁
ドコモ決済番号
異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード

DocomoContinuanceShopEnd 継続課金終了(加盟店様)

加盟店様にて継続課金の終了を行います。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID
Amount amount 必須 半角数字6桁
利用金額
Tax tax 半角数字6桁
税送料
LastMonthFreeFlag lastMonthFreeFlag 必須 半角数字1桁
終了月無料区分

終了月の課金を無料にするか指定します。
0：終了月無料にしない
1：終了月無料にする

URL
/payment/DocomoContinuanceShopEnd.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1000",
  "lastMonthFreeFlag": "0"
}
URL
/payment/DocomoContinuanceShopEnd.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000&LastMonthFreeFlag=0
レスポンス
正常
OrderID orderID 半角英数記号27桁
オーダーID
Status status
現状態

継続課金終了(加盟店様)要求成功時は以下のステータスが返却されます。
RUN-END：契約終了処理中

Amount amount 半角数字6桁
利用金額
Tax tax 半角数字6桁
税送料
異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "orderID": "ORDER0000001",
  "status": "RUN-END",
  "amount": "1000",
  "tax": "0"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=RUN-END&Amount=1000&Tax=0
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

DocomoContinuanceSales 課金データ減額確定

課金データの減額確定を行います。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID
Amount amount 必須 半角数字6桁
利用金額
Tax tax 半角数字6桁
税送料

利用金額＋税送料が減額確定金額となります（1円以上）
※確定前金額より大きい金額の場合はエラーとします。

URL
/payment/DocomoContinuanceSales.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1100"
}
URL
/payment/DocomoContinuanceSales.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1100
レスポンス
正常
OrderID orderID 半角英数記号27桁
オーダーID
Status status
現状態

減額確定成功時は以下のステータスが返却されます。
RUN：処理中
Amount amount 半角数字6桁
利用金額
Tax tax 半角数字6桁
税送料
異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "orderID": "ORDER0000001",
  "status": "RUN",
  "amount": "1100",
  "tax": "0"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=RUN&Amount=1100&Tax=0
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

DocomoContinuanceCancelReturn 課金データキャンセル・返品

課金データのキャンセル・返品を行います。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
AccessID accessID 必須 半角英数32桁 固定
取引ID
AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID
CancelAmount cancelAmount 必須 半角数字6桁
キャンセル金額
CancelTax cancelTax 半角数字6桁
キャンセル税送料

キャンセル金額＋キャンセル税送料をキャンセル金額とします。（1円以上）
例）請求525円より全額キャンセル→キャンセル金額：525
請求525円より210円分キャンセル→キャンセル金額：210

ContinuanceMonth continuanceMonth 必須 半角数字6桁 固定
継続課金年月

キャンセル・返品する継続課金の年月をyyyyMM形式で指定してください。

URL
/payment/DocomoContinuanceCancelReturn.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "cancelAmount": "1000",
  "continuanceMonth": "202201"
}
URL
/payment/DocomoContinuanceCancelReturn.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=1000&ContinuanceMonth=202201
レスポンス
正常
OrderID orderID 半角英数記号27桁
オーダーID
Status status
現状態

キャンセル・返品成功時は以下のステータスが返却されます。
RUN：処理中

Amount amount 半角数字6桁
利用金額

利用金額からキャンセル金額を減算した結果を返却します。
例）利用金額500円よりキャンセル金額300円 => 利用金額200円

Tax tax 半角数字6桁
税送料

税送料からキャンセル税送料を減算した結果を返却します。
例）税送料250円よりキャンセル税送料150円 => 税送料100円

CancelAmount cancelAmount 半角数字6桁
キャンセル金額

キャンセル金額を返却します。

CancelTax cancelTax 半角数字6桁
キャンセル税送料

キャンセル税送料を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "orderID": "ORDER0000001",
  "status": "RUN",
  "amount": "0",
  "tax": "0",
  "cancelAmount": "1000",
  "cancelTax": "0"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=RUN&Amount=0&Tax=0&CancelAmount=1000&CancelTax=0
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeDocomoContinuance/SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。
※SearchTradeMultiはidPass版にのみ対応しています。json版には対応しておりません。

リクエスト
ShopID shopID 必須 半角英数13桁
ショップID
ShopPass shopPass 必須 半角英数64桁
ショップパスワード
OrderID orderID 必須 半角英数記号27桁
オーダーID
PayType payType 半角数字2桁
決済方法

SearchTradeMultiをご利用の際は「10」を指定してください。
SearchTradeDocomoをご利用の際は設定不要です。

URL
/payment/SearchTradeDocomoContinuance.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001"
}
URL：SearchTradeDocomoContinuanceの場合
/payment/SearchTradeDocomoContinuance.idPass
URL：SearchTradeMultiの場合
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001
レスポンス
正常
Status status
現状態

UNPROCESSED：登録手続中
REQSUCCESS：要求成功
AUTHPROCESS：認証処理中
PAYFAIL：決済失敗
REGISTER：契約中
END：契約終了
ERASE：抹消
RUN-CHANGE：変更処理中
RUN-END：契約終了処理中
ProcessDate processDate 半角数字14桁 固定
処理日時

処理を実施した日時を返却します。
yyyyMMddHHmmss書式

JobCd jobCd
処理区分

REGISTER：契約中
END：終了
AccessID accessID 半角英数32桁 固定
取引ID
AccessPass accessPass 半角英数32桁 固定
取引パスワード
Amount amount 半角数字10桁
利用金額
Tax tax 半角数字10桁
税送料
Currency currency 半角英字3桁
通貨コード

空欄を返却します。
ClientField1 clientField1 全半角100バイト
加盟店自由項目1
ClientField2 clientField2 全半角100バイト
加盟店自由項目2
ClientField3 clientField3 全半角100バイト
加盟店自由項目3
PayType payType 半角数字2桁
決済方法

10：d払い(継続課金)
DocomoSettlementCode docomoSettlementCode 半角数字12桁
ドコモ決済番号
DocomoCancelAmount docomoCancelAmount 半角数字6桁
ドコモキャンセル金額

キャンセル・返品した金額を返却します。

DocomoCancelTax docomoCancelTax 半角数字6桁
ドコモキャンセル税送料

キャンセル・返品した税送料を返却します。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "status": "REGISTER",
  "processDate": "20190213200436",
  "jobCd": "REGISTER",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "amount": "1000",
  "tax": "0",
  "currency": "",
  "clientField1": "",
  "clientField2": "",
  "clientField3": "",
  "payType": "10",
  "docomoSettlementCode": "411178431948",
  "docomoCancelAmount": "100",
  "docomoCancelTax": "0"
}
レスポンスパラメータ：正常系
Status=REGISTER&ProcessDate=20190213200436&JobCd=REGISTER&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=0&Currency=&ClientField1=&ClientField2=&ClientField3=&PayType=10&DocomoSettlementCode=411178431948&DocomoCancelAmount=100&DocomoCancelTax=0
レスポンスパラメータ：異常系
[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001